<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.io.output;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.OutputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.Writer;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.nio.ByteBuffer;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.nio.CharBuffer;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.nio.charset.Charset;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.nio.charset.CharsetDecoder;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.nio.charset.CoderResult;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.nio.charset.CodingErrorAction;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * {@link OutputStream} implementation that transforms a byte stream to a<a name="line.30"></a>
<span class="sourceLineNo">031</span> * character stream using a specified charset encoding and writes the resulting<a name="line.31"></a>
<span class="sourceLineNo">032</span> * stream to a {@link Writer}. The stream is transformed using a<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link CharsetDecoder} object, guaranteeing that all charset<a name="line.33"></a>
<span class="sourceLineNo">034</span> * encodings supported by the JRE are handled correctly.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * The output of the {@link CharsetDecoder} is buffered using a fixed size buffer.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * This implies that the data is written to the underlying {@link Writer} in chunks<a name="line.37"></a>
<span class="sourceLineNo">038</span> * that are no larger than the size of this buffer. By default, the buffer is<a name="line.38"></a>
<span class="sourceLineNo">039</span> * flushed only when it overflows or when {@link #flush()} or {@link #close()}<a name="line.39"></a>
<span class="sourceLineNo">040</span> * is called. In general there is therefore no need to wrap the underlying {@link Writer}<a name="line.40"></a>
<span class="sourceLineNo">041</span> * in a {@link java.io.BufferedWriter}. {@link WriterOutputStream} can also<a name="line.41"></a>
<span class="sourceLineNo">042</span> * be instructed to flush the buffer after each write operation. In this case, all<a name="line.42"></a>
<span class="sourceLineNo">043</span> * available data is written immediately to the underlying {@link Writer}, implying that<a name="line.43"></a>
<span class="sourceLineNo">044</span> * the current position of the {@link Writer} is correlated to the current position<a name="line.44"></a>
<span class="sourceLineNo">045</span> * of the {@link WriterOutputStream}.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;p&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * {@link WriterOutputStream} implements the inverse transformation of {@link java.io.OutputStreamWriter};<a name="line.47"></a>
<span class="sourceLineNo">048</span> * in the following example, writing to {@code out2} would have the same result as writing to<a name="line.48"></a>
<span class="sourceLineNo">049</span> * {@code out} directly (provided that the byte sequence is legal with respect to the<a name="line.49"></a>
<span class="sourceLineNo">050</span> * charset encoding):<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;pre&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * OutputStream out = ...<a name="line.52"></a>
<span class="sourceLineNo">053</span> * Charset cs = ...<a name="line.53"></a>
<span class="sourceLineNo">054</span> * OutputStreamWriter writer = new OutputStreamWriter(out, cs);<a name="line.54"></a>
<span class="sourceLineNo">055</span> * WriterOutputStream out2 = new WriterOutputStream(writer, cs);&lt;/pre&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * {@link WriterOutputStream} implements the same transformation as {@link java.io.InputStreamReader},<a name="line.56"></a>
<span class="sourceLineNo">057</span> * except that the control flow is reversed: both classes transform a byte stream<a name="line.57"></a>
<span class="sourceLineNo">058</span> * into a character stream, but {@link java.io.InputStreamReader} pulls data from the underlying stream,<a name="line.58"></a>
<span class="sourceLineNo">059</span> * while {@link WriterOutputStream} pushes it to the underlying stream.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Note that while there are use cases where there is no alternative to using<a name="line.61"></a>
<span class="sourceLineNo">062</span> * this class, very often the need to use this class is an indication of a flaw<a name="line.62"></a>
<span class="sourceLineNo">063</span> * in the design of the code. This class is typically used in situations where an existing<a name="line.63"></a>
<span class="sourceLineNo">064</span> * API only accepts an {@link OutputStream} object, but where the stream is known to represent<a name="line.64"></a>
<span class="sourceLineNo">065</span> * character data that must be decoded for further use.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;/p&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;p&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Instances of {@link WriterOutputStream} are not thread safe.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;/p&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @see org.apache.commons.io.input.ReaderInputStream<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @since 2.0<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span>public class WriterOutputStream extends OutputStream {<a name="line.74"></a>
<span class="sourceLineNo">075</span>    private static final int BUFFER_SIZE = 1024;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    private final Writer writer;<a name="line.77"></a>
<span class="sourceLineNo">078</span>    private final CharsetDecoder decoder;<a name="line.78"></a>
<span class="sourceLineNo">079</span>    private final boolean writeImmediately;<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span>    /**<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * ByteBuffer used as input for the decoder. This buffer can be small<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * as it is used only to transfer the received data to the<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * decoder.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     */<a name="line.85"></a>
<span class="sourceLineNo">086</span>    private final ByteBuffer decoderIn = ByteBuffer.allocate(128);<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * CharBuffer used as output for the decoder. It should be<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * somewhat larger as we write from this buffer to the<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * underlying Writer.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    private final CharBuffer decoderOut;<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span>    /**<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * Constructs a new {@link WriterOutputStream} with a default output buffer size of {@value #BUFFER_SIZE}<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * characters. The output buffer will only be flushed when it overflows or when {@link #flush()} or {@link #close()}<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * is called.<a name="line.98"></a>
<span class="sourceLineNo">099</span>     *<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * @param writer the target {@link Writer}<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * @param decoder the charset decoder<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * @since 2.1<a name="line.102"></a>
<span class="sourceLineNo">103</span>     */<a name="line.103"></a>
<span class="sourceLineNo">104</span>    public WriterOutputStream(final Writer writer, final CharsetDecoder decoder) {<a name="line.104"></a>
<span class="sourceLineNo">105</span>        this(writer, decoder, BUFFER_SIZE, false);<a name="line.105"></a>
<span class="sourceLineNo">106</span>    }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * Constructs a new {@link WriterOutputStream}.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     *<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * @param writer the target {@link Writer}<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * @param decoder the charset decoder<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * @param bufferSize the size of the output buffer in number of characters<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param writeImmediately If {@code true} the output buffer will be flushed after each<a name="line.114"></a>
<span class="sourceLineNo">115</span>     *                         write operation, i.e. all available data will be written to the<a name="line.115"></a>
<span class="sourceLineNo">116</span>     *                         underlying {@link Writer} immediately. If {@code false}, the<a name="line.116"></a>
<span class="sourceLineNo">117</span>     *                         output buffer will only be flushed when it overflows or when<a name="line.117"></a>
<span class="sourceLineNo">118</span>     *                         {@link #flush()} or {@link #close()} is called.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @since 2.1<a name="line.119"></a>
<span class="sourceLineNo">120</span>     */<a name="line.120"></a>
<span class="sourceLineNo">121</span>    public WriterOutputStream(final Writer writer, final CharsetDecoder decoder, final int bufferSize,<a name="line.121"></a>
<span class="sourceLineNo">122</span>                              final boolean writeImmediately) {<a name="line.122"></a>
<span class="sourceLineNo">123</span>        checkIbmJdkWithBrokenUTF16( decoder.charset());<a name="line.123"></a>
<span class="sourceLineNo">124</span>        this.writer = writer;<a name="line.124"></a>
<span class="sourceLineNo">125</span>        this.decoder = decoder;<a name="line.125"></a>
<span class="sourceLineNo">126</span>        this.writeImmediately = writeImmediately;<a name="line.126"></a>
<span class="sourceLineNo">127</span>        decoderOut = CharBuffer.allocate(bufferSize);<a name="line.127"></a>
<span class="sourceLineNo">128</span>    }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span>    /**<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * Constructs a new {@link WriterOutputStream}.<a name="line.131"></a>
<span class="sourceLineNo">132</span>     *<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * @param writer the target {@link Writer}<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * @param charset the charset encoding<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * @param bufferSize the size of the output buffer in number of characters<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * @param writeImmediately If {@code true} the output buffer will be flushed after each<a name="line.136"></a>
<span class="sourceLineNo">137</span>     *                         write operation, i.e. all available data will be written to the<a name="line.137"></a>
<span class="sourceLineNo">138</span>     *                         underlying {@link Writer} immediately. If {@code false}, the<a name="line.138"></a>
<span class="sourceLineNo">139</span>     *                         output buffer will only be flushed when it overflows or when<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *                         {@link #flush()} or {@link #close()} is called.<a name="line.140"></a>
<span class="sourceLineNo">141</span>     */<a name="line.141"></a>
<span class="sourceLineNo">142</span>    public WriterOutputStream(final Writer writer, final Charset charset, final int bufferSize,<a name="line.142"></a>
<span class="sourceLineNo">143</span>                              final boolean writeImmediately) {<a name="line.143"></a>
<span class="sourceLineNo">144</span>        this(writer,<a name="line.144"></a>
<span class="sourceLineNo">145</span>             charset.newDecoder()<a name="line.145"></a>
<span class="sourceLineNo">146</span>                    .onMalformedInput(CodingErrorAction.REPLACE)<a name="line.146"></a>
<span class="sourceLineNo">147</span>                    .onUnmappableCharacter(CodingErrorAction.REPLACE)<a name="line.147"></a>
<span class="sourceLineNo">148</span>                    .replaceWith("?"),<a name="line.148"></a>
<span class="sourceLineNo">149</span>             bufferSize,<a name="line.149"></a>
<span class="sourceLineNo">150</span>             writeImmediately);<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>    /**<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * Constructs a new {@link WriterOutputStream} with a default output buffer size of {@value #BUFFER_SIZE}<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * characters. The output buffer will only be flushed when it overflows or when {@link #flush()} or {@link #close()}<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * is called.<a name="line.156"></a>
<span class="sourceLineNo">157</span>     *<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * @param writer the target {@link Writer}<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * @param charset the charset encoding<a name="line.159"></a>
<span class="sourceLineNo">160</span>     */<a name="line.160"></a>
<span class="sourceLineNo">161</span>    public WriterOutputStream(final Writer writer, final Charset charset) {<a name="line.161"></a>
<span class="sourceLineNo">162</span>        this(writer, charset, BUFFER_SIZE, false);<a name="line.162"></a>
<span class="sourceLineNo">163</span>    }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span>    /**<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * Constructs a new {@link WriterOutputStream}.<a name="line.166"></a>
<span class="sourceLineNo">167</span>     *<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * @param writer the target {@link Writer}<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * @param charsetName the name of the charset encoding<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * @param bufferSize the size of the output buffer in number of characters<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * @param writeImmediately If {@code true} the output buffer will be flushed after each<a name="line.171"></a>
<span class="sourceLineNo">172</span>     *                         write operation, i.e. all available data will be written to the<a name="line.172"></a>
<span class="sourceLineNo">173</span>     *                         underlying {@link Writer} immediately. If {@code false}, the<a name="line.173"></a>
<span class="sourceLineNo">174</span>     *                         output buffer will only be flushed when it overflows or when<a name="line.174"></a>
<span class="sourceLineNo">175</span>     *                         {@link #flush()} or {@link #close()} is called.<a name="line.175"></a>
<span class="sourceLineNo">176</span>     */<a name="line.176"></a>
<span class="sourceLineNo">177</span>    public WriterOutputStream(final Writer writer, final String charsetName, final int bufferSize,<a name="line.177"></a>
<span class="sourceLineNo">178</span>                              final boolean writeImmediately) {<a name="line.178"></a>
<span class="sourceLineNo">179</span>        this(writer, Charset.forName(charsetName), bufferSize, writeImmediately);<a name="line.179"></a>
<span class="sourceLineNo">180</span>    }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span>    /**<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * Constructs a new {@link WriterOutputStream} with a default output buffer size of {@value #BUFFER_SIZE}<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * characters. The output buffer will only be flushed when it overflows or when {@link #flush()} or {@link #close()}<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * is called.<a name="line.185"></a>
<span class="sourceLineNo">186</span>     *<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * @param writer the target {@link Writer}<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * @param charsetName the name of the charset encoding<a name="line.188"></a>
<span class="sourceLineNo">189</span>     */<a name="line.189"></a>
<span class="sourceLineNo">190</span>    public WriterOutputStream(final Writer writer, final String charsetName) {<a name="line.190"></a>
<span class="sourceLineNo">191</span>        this(writer, charsetName, BUFFER_SIZE, false);<a name="line.191"></a>
<span class="sourceLineNo">192</span>    }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span>    /**<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * Constructs a new {@link WriterOutputStream} that uses the default character encoding and with a default output<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * buffer size of {@value #BUFFER_SIZE} characters. The output buffer will only be flushed when it overflows or when<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * {@link #flush()} or {@link #close()} is called.<a name="line.197"></a>
<span class="sourceLineNo">198</span>     *<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * @param writer the target {@link Writer}<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * @deprecated 2.5 use {@link #WriterOutputStream(Writer, Charset)} instead<a name="line.200"></a>
<span class="sourceLineNo">201</span>     */<a name="line.201"></a>
<span class="sourceLineNo">202</span>    @Deprecated<a name="line.202"></a>
<span class="sourceLineNo">203</span>    public WriterOutputStream(final Writer writer) {<a name="line.203"></a>
<span class="sourceLineNo">204</span>        this(writer, Charset.defaultCharset(), BUFFER_SIZE, false);<a name="line.204"></a>
<span class="sourceLineNo">205</span>    }<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span>    /**<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * Write bytes from the specified byte array to the stream.<a name="line.208"></a>
<span class="sourceLineNo">209</span>     *<a name="line.209"></a>
<span class="sourceLineNo">210</span>     * @param b the byte array containing the bytes to write<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * @param off the start offset in the byte array<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * @param len the number of bytes to write<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * @throws IOException if an I/O error occurs.<a name="line.213"></a>
<span class="sourceLineNo">214</span>     */<a name="line.214"></a>
<span class="sourceLineNo">215</span>    @Override<a name="line.215"></a>
<span class="sourceLineNo">216</span>    public void write(final byte[] b, int off, int len) throws IOException {<a name="line.216"></a>
<span class="sourceLineNo">217</span>        while (len &gt; 0) {<a name="line.217"></a>
<span class="sourceLineNo">218</span>            final int c = Math.min(len, decoderIn.remaining());<a name="line.218"></a>
<span class="sourceLineNo">219</span>            decoderIn.put(b, off, c);<a name="line.219"></a>
<span class="sourceLineNo">220</span>            processInput(false);<a name="line.220"></a>
<span class="sourceLineNo">221</span>            len -= c;<a name="line.221"></a>
<span class="sourceLineNo">222</span>            off += c;<a name="line.222"></a>
<span class="sourceLineNo">223</span>        }<a name="line.223"></a>
<span class="sourceLineNo">224</span>        if (writeImmediately) {<a name="line.224"></a>
<span class="sourceLineNo">225</span>            flushOutput();<a name="line.225"></a>
<span class="sourceLineNo">226</span>        }<a name="line.226"></a>
<span class="sourceLineNo">227</span>    }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span>    /**<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * Write bytes from the specified byte array to the stream.<a name="line.230"></a>
<span class="sourceLineNo">231</span>     *<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * @param b the byte array containing the bytes to write<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * @throws IOException if an I/O error occurs.<a name="line.233"></a>
<span class="sourceLineNo">234</span>     */<a name="line.234"></a>
<span class="sourceLineNo">235</span>    @Override<a name="line.235"></a>
<span class="sourceLineNo">236</span>    public void write(final byte[] b) throws IOException {<a name="line.236"></a>
<span class="sourceLineNo">237</span>        write(b, 0, b.length);<a name="line.237"></a>
<span class="sourceLineNo">238</span>    }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span>    /**<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * Write a single byte to the stream.<a name="line.241"></a>
<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * @param b the byte to write<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * @throws IOException if an I/O error occurs.<a name="line.244"></a>
<span class="sourceLineNo">245</span>     */<a name="line.245"></a>
<span class="sourceLineNo">246</span>    @Override<a name="line.246"></a>
<span class="sourceLineNo">247</span>    public void write(final int b) throws IOException {<a name="line.247"></a>
<span class="sourceLineNo">248</span>        write(new byte[] {(byte) b}, 0, 1);<a name="line.248"></a>
<span class="sourceLineNo">249</span>    }<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span>    /**<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * Flush the stream. Any remaining content accumulated in the output buffer<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * will be written to the underlying {@link Writer}. After that<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * {@link Writer#flush()} will be called.<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * @throws IOException if an I/O error occurs.<a name="line.255"></a>
<span class="sourceLineNo">256</span>     */<a name="line.256"></a>
<span class="sourceLineNo">257</span>    @Override<a name="line.257"></a>
<span class="sourceLineNo">258</span>    public void flush() throws IOException {<a name="line.258"></a>
<span class="sourceLineNo">259</span>        flushOutput();<a name="line.259"></a>
<span class="sourceLineNo">260</span>        writer.flush();<a name="line.260"></a>
<span class="sourceLineNo">261</span>    }<a name="line.261"></a>
<span class="sourceLineNo">262</span><a name="line.262"></a>
<span class="sourceLineNo">263</span>    /**<a name="line.263"></a>
<span class="sourceLineNo">264</span>     * Close the stream. Any remaining content accumulated in the output buffer<a name="line.264"></a>
<span class="sourceLineNo">265</span>     * will be written to the underlying {@link Writer}. After that<a name="line.265"></a>
<span class="sourceLineNo">266</span>     * {@link Writer#close()} will be called.<a name="line.266"></a>
<span class="sourceLineNo">267</span>     * @throws IOException if an I/O error occurs.<a name="line.267"></a>
<span class="sourceLineNo">268</span>     */<a name="line.268"></a>
<span class="sourceLineNo">269</span>    @Override<a name="line.269"></a>
<span class="sourceLineNo">270</span>    public void close() throws IOException {<a name="line.270"></a>
<span class="sourceLineNo">271</span>        processInput(true);<a name="line.271"></a>
<span class="sourceLineNo">272</span>        flushOutput();<a name="line.272"></a>
<span class="sourceLineNo">273</span>        writer.close();<a name="line.273"></a>
<span class="sourceLineNo">274</span>    }<a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span>    /**<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * Decode the contents of the input ByteBuffer into a CharBuffer.<a name="line.277"></a>
<span class="sourceLineNo">278</span>     *<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * @param endOfInput indicates end of input<a name="line.279"></a>
<span class="sourceLineNo">280</span>     * @throws IOException if an I/O error occurs.<a name="line.280"></a>
<span class="sourceLineNo">281</span>     */<a name="line.281"></a>
<span class="sourceLineNo">282</span>    private void processInput(final boolean endOfInput) throws IOException {<a name="line.282"></a>
<span class="sourceLineNo">283</span>        // Prepare decoderIn for reading<a name="line.283"></a>
<span class="sourceLineNo">284</span>        decoderIn.flip();<a name="line.284"></a>
<span class="sourceLineNo">285</span>        CoderResult coderResult;<a name="line.285"></a>
<span class="sourceLineNo">286</span>        while (true) {<a name="line.286"></a>
<span class="sourceLineNo">287</span>            coderResult = decoder.decode(decoderIn, decoderOut, endOfInput);<a name="line.287"></a>
<span class="sourceLineNo">288</span>            if (coderResult.isOverflow()) {<a name="line.288"></a>
<span class="sourceLineNo">289</span>                flushOutput();<a name="line.289"></a>
<span class="sourceLineNo">290</span>            } else if (coderResult.isUnderflow()) {<a name="line.290"></a>
<span class="sourceLineNo">291</span>                break;<a name="line.291"></a>
<span class="sourceLineNo">292</span>            } else {<a name="line.292"></a>
<span class="sourceLineNo">293</span>                // The decoder is configured to replace malformed input and unmappable characters,<a name="line.293"></a>
<span class="sourceLineNo">294</span>                // so we should not get here.<a name="line.294"></a>
<span class="sourceLineNo">295</span>                throw new IOException("Unexpected coder result");<a name="line.295"></a>
<span class="sourceLineNo">296</span>            }<a name="line.296"></a>
<span class="sourceLineNo">297</span>        }<a name="line.297"></a>
<span class="sourceLineNo">298</span>        // Discard the bytes that have been read<a name="line.298"></a>
<span class="sourceLineNo">299</span>        decoderIn.compact();<a name="line.299"></a>
<span class="sourceLineNo">300</span>    }<a name="line.300"></a>
<span class="sourceLineNo">301</span><a name="line.301"></a>
<span class="sourceLineNo">302</span>    /**<a name="line.302"></a>
<span class="sourceLineNo">303</span>     * Flush the output.<a name="line.303"></a>
<span class="sourceLineNo">304</span>     *<a name="line.304"></a>
<span class="sourceLineNo">305</span>     * @throws IOException if an I/O error occurs.<a name="line.305"></a>
<span class="sourceLineNo">306</span>     */<a name="line.306"></a>
<span class="sourceLineNo">307</span>    private void flushOutput() throws IOException {<a name="line.307"></a>
<span class="sourceLineNo">308</span>        if (decoderOut.position() &gt; 0) {<a name="line.308"></a>
<span class="sourceLineNo">309</span>            writer.write(decoderOut.array(), 0, decoderOut.position());<a name="line.309"></a>
<span class="sourceLineNo">310</span>            decoderOut.rewind();<a name="line.310"></a>
<span class="sourceLineNo">311</span>        }<a name="line.311"></a>
<span class="sourceLineNo">312</span>    }<a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span>    /**<a name="line.314"></a>
<span class="sourceLineNo">315</span>     * Check if the JDK in use properly supports the given charset.<a name="line.315"></a>
<span class="sourceLineNo">316</span>     *<a name="line.316"></a>
<span class="sourceLineNo">317</span>     * @param charset the charset to check the support for<a name="line.317"></a>
<span class="sourceLineNo">318</span>     */<a name="line.318"></a>
<span class="sourceLineNo">319</span>    private static void checkIbmJdkWithBrokenUTF16(final Charset charset){<a name="line.319"></a>
<span class="sourceLineNo">320</span>        if (!"UTF-16".equals(charset.name())) {<a name="line.320"></a>
<span class="sourceLineNo">321</span>            return;<a name="line.321"></a>
<span class="sourceLineNo">322</span>        }<a name="line.322"></a>
<span class="sourceLineNo">323</span>        final String TEST_STRING_2 = "v\u00e9s";<a name="line.323"></a>
<span class="sourceLineNo">324</span>        final byte[] bytes = TEST_STRING_2.getBytes(charset);<a name="line.324"></a>
<span class="sourceLineNo">325</span><a name="line.325"></a>
<span class="sourceLineNo">326</span>        final CharsetDecoder charsetDecoder2 = charset.newDecoder();<a name="line.326"></a>
<span class="sourceLineNo">327</span>        final ByteBuffer bb2 = ByteBuffer.allocate(16);<a name="line.327"></a>
<span class="sourceLineNo">328</span>        final CharBuffer cb2 = CharBuffer.allocate(TEST_STRING_2.length());<a name="line.328"></a>
<span class="sourceLineNo">329</span>        final int len = bytes.length;<a name="line.329"></a>
<span class="sourceLineNo">330</span>        for (int i = 0; i &lt; len; i++) {<a name="line.330"></a>
<span class="sourceLineNo">331</span>            bb2.put(bytes[i]);<a name="line.331"></a>
<span class="sourceLineNo">332</span>            bb2.flip();<a name="line.332"></a>
<span class="sourceLineNo">333</span>            try {<a name="line.333"></a>
<span class="sourceLineNo">334</span>                charsetDecoder2.decode(bb2, cb2, i == (len - 1));<a name="line.334"></a>
<span class="sourceLineNo">335</span>            } catch ( final IllegalArgumentException e){<a name="line.335"></a>
<span class="sourceLineNo">336</span>                throw new UnsupportedOperationException("UTF-16 requested when running on an IBM JDK with broken UTF-16 support. " +<a name="line.336"></a>
<span class="sourceLineNo">337</span>                        "Please find a JDK that supports UTF-16 if you intend to use UF-16 with WriterOutputStream");<a name="line.337"></a>
<span class="sourceLineNo">338</span>            }<a name="line.338"></a>
<span class="sourceLineNo">339</span>            bb2.compact();<a name="line.339"></a>
<span class="sourceLineNo">340</span>        }<a name="line.340"></a>
<span class="sourceLineNo">341</span>        cb2.rewind();<a name="line.341"></a>
<span class="sourceLineNo">342</span>        if (!TEST_STRING_2.equals(cb2.toString())){<a name="line.342"></a>
<span class="sourceLineNo">343</span>            throw new UnsupportedOperationException("UTF-16 requested when running on an IBM JDK with broken UTF-16 support. " +<a name="line.343"></a>
<span class="sourceLineNo">344</span>                    "Please find a JDK that supports UTF-16 if you intend to use UF-16 with WriterOutputStream");<a name="line.344"></a>
<span class="sourceLineNo">345</span>        }<a name="line.345"></a>
<span class="sourceLineNo">346</span><a name="line.346"></a>
<span class="sourceLineNo">347</span>    }<a name="line.347"></a>
<span class="sourceLineNo">348</span>}<a name="line.348"></a>




























































</pre>
</div>
</body>
</html>
